MarkLogic 12 Product Documentation

GET /manage/v2/servers/{id|name}?view=status

Summary

This resource address returns status information about a specific App Server. The server can be identified either by id or name.

Response

Upon success, MarkLogic Server returns status code 200 (OK), and the response body contains the requested data.

Required Privileges

http://marklogic.com/xdmp/privileges/manage

Usage Notes

The structure of the output returned from this REST API is as follows:

id

An HTTP server id.

name

An HTTP server name.

server-kind

The kind of server, which is either http, task, webDAV, xdbc, or odbc.

meta

Properties of the view rather than the resource.

This is a complex structure with the following children:

uri

The path to the view.

current-time

The timestamp for when the view was generated.

elapsed-time

The time required to construct the view. The elapsed time indicates the relative cost of generating the view. Consider the cost when determining how frequently to request a view.

start-min

The timestamp for filtering out more recent requests or transactions.

view-error

An error limiting the data in the view.

This is a complex structure with the following children:

error-type

The kind of error.

error-name

The name of the error.

error-code

The error identifier.

error-message

The error text.

relations

Relationships to resources.

This is a complex structure with the following children:

relation-group

Related resources with the same type.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

relation-count

The number of related resources.

relation

A specific related resource.

This is a complex structure with the following children:

qualifiers

A list of associated resources that distinguish the resource.

This is a complex structure with the following children:

qualifier

Another resource that qualifies the resource.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

status-properties

The operating characteristics of the server.

This is a complex structure with the following children:

enabled

Appserver enabled status.

port

The server socket bind internet port number.

root

The root document directory pathname. The module directory root. The module directory root.

display-last-login

Indicates whether an appserver should display users' last login information.

backlog

The socket listen backlog.

threads

The maximum number of server threads allowed on each host in the group; the server may also additionally limit threads.

max-threads

The maximum number of application server threads allowed on each host in the group.

request-timeout

The request socket recv timeout, in seconds.

keep-alive-timeout

The keep-alive socket recv timeout, in seconds.

session-timeout

The session expiration timeout, in seconds.

static-expires

Add an "expires" HTTP header for static content to expire after this many seconds.

max-time-limit

The upper bound for a request's time limit, in seconds.

default-time-limit

The default time limit for a request, in seconds.

max-inference-size

The upper bound for a request's inference size, in megabytes.

default-inference-size

The default inference size for a request, in megabytes.

multi-version-concurrency-control

Specifies concurrency control of read-only queries.

authentication

The authentication scheme to use for this server

default-user

The user used as the default user in application level authentication. Using the admin user as the default user is equivalent to turning security off.

privilege

The privilege restricting access to the server.

concurrent-request-limit

The maximum number of concurrent requests per user.

default-xquery-version

The default XQuery language version for this server.

output-sgml-character-entities

Output SGML character entities.

output-encoding

The default output encoding.

error-handler

The script that handles 400 and 500 errors for this server.

url-rewriter

The script that rewrites URLs for this server.

total-request-rate

The rounded sum of the request rate in requests per second.

total-expanded-tree-cache-miss-rate

The rounded sum of the average number of misses on the expanded cache.

total-expanded-tree-cache-hit-rate

The rounded sum of the average number of hits on the expanded cache.

total-requests

The total number of requests for the server.

content-database-enabled

modules-database-enabled

directory-creation

last-login-database-enabled

host-detail

The detail about the status of the server on the host.

This is a complex structure with the following children:

relation

A specific related resource.

This is a complex structure with the following children:

qualifiers

A list of associated resources that distinguish the resource.

This is a complex structure with the following children:

qualifier

Another resource that qualifies the resource.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

relation-id

A group or host related to the server.

requests-count

The total number of requests for the server on the host.

max-inference-size

The upper bound for a request's inference size, in megabytes.

default-inference-size

The default inference size for a request, in megabytes.

error

The error in processing server status.

ssl-certificate-template

The certificate template. When a certificate template is specified, the App Server uses an SSL encrypted protocol (e.g. https, davs, xccs). The certificate template specifies the common information for the individual SSL certificates needed for each host in the group.

You can add a new certificate template by navigating to Security > Certificate Templates > Create

address

The server socket bind numeric internet address.

collation

The default collation for queries.

distribute-timestamps

Specifies the distribution of commit timestamps after updates.

request-rate

The rate of a request (requests/sec).

queue-size

The maximum number of tasks allowed.

queue-limit

The maximum number size of the queue.

expanded-tree-cache-hits

The number of hits on the expanded cache.

expanded-tree-cache-misses

The number of misses on the expanded cache.

expanded-tree-cache-hit-rate

The average number of hits on the expanded cache.

expanded-tree-cache-miss-rate

The average number of misses on the expanded cache.

fs-program-cache-hits

The number of hits on the filesystem program cache.

fs-program-cache-misses

The number of misses on the filesystem program cache.

db-program-cache-hits

The number of hits on the database program cache.

db-program-cache-misses

The number of misses on the database program cache.

env-program-cache-hits

The number of hits on the XSLT environment program cache.

env-program-cache-misses

The number of misses on the XSLT environment program cache.

fs-main-module-seq-cache-hits

The number of hits on the filesystem main module sequence cache.

fs-main-module-seq-cache-misses

The number of misses on the filesystem main module sequence cache.

db-main-module-seq-cache-hits

The number of hits on the database main module sequence cache.

db-main-module-seq-cache-misses

The number of misses on the database main module sequence cache.

fs-lib-module-cache-hits

The number of hits on the filesystem library module cache.

fs-lib-module-cache-misses

The number of misses on the filesystem library module cache.

db-lib-module-cache-hits

The number of hits on the database library module cache.

db-lib-module-cache-misses

The number of misses on the database library module cache.

fs-schema-cache-hits

The number of hits on the filesystem schema cache.

fs-schema-cache-misses

The number of misses on the filesystem schema cache.

db-schema-cache-hits

The number of hits on the database schema cache.

db-schema-cache-misses

The number of misses on the database schema cache.

env-schema-cache-hits

The number of hits on the environment schema cache.

env-schema-cache-misses

The number of misses on the environment schema cache.

temporary-file-read-bytes

The total number of bytes read from temporary files for example for external sort and join.

temporary-file-write-bytes

The total number of bytes written to temporary files for example for external sort and join.

hosts

The host's view of all other hosts in the cluster.

This is a complex structure with the following children:

host

The host connection information.

This is a complex structure with the following children:

host-name

The internet host name.

round-trip-count

The total of round-trip communications between the App Server host and this host. A round trip is the completion of a request sent from the App Server host to another host in the cluster.

round-trip-time

The total time (as xs:dayTimeDuration) to complete the round trips from the App Server to this host.

round-trip-rate

The moving average data throughput of sending a request and receiving result in a round trip, in megabytes per second.

round-trip-load

Time threads spent in sending a request and receiving results in round-trips, in proportion to the elapsed time.

default-error-format

The default error format for protocol errors. One of html,xml,json,compatiable

request-time

1 minute average of request time for this server.

server-receive-bytes

The number of bytes received over the network.

server-receive-time

The time (as xs:dayTimeDuration) to receive over the network.

server-receive-rate

The moving average of incoming network throughput, in megabytes per second.

server-receive-load

Network time threads spent receiving data, in proportion to the elapsed time.

server-send-bytes

The number of bytes sent over the network.

server-send-time

The time (as xs:dayTimeDuration) to send over the network.

server-send-rate

The moving average of outgoing network throughput, in megabytes per second.

server-send-load

Network time threads spent sending data, in proportion to the elapsed time.

related-views

A list of broader or narrower views on the resource or resource type.

This is a complex structure with the following children:

related-view

A broader or narrower view on the resource or resource type.

This is a complex structure with the following children:

view-type

The kind of view.

view-name

The name of the view.

view-uri

The path for the view.

Example

http://localhost:8002/manage/v2/servers/Admin?group-id=Default&view=status

==>  Returns the status of the Admin server in the Default group.